Skip to content

Template 0.1.38: merged and corrected guides from the docs audit - #62

Merged
guijacquemet merged 10 commits into
mainfrom
claude/stardist-labconstrictor-plan-aizdd6
Nov 18, 2026
Merged

guijacquemet merged 10 commits into
mainfrom
claude/stardist-labconstrictor-plan-aizdd6

Conversation

@guijacquemet

Copy link
Copy Markdown
Collaborator

Docs audit follow-up, phase 1 items 4–6 and phase 2 items 9–11 and 14.

Guides (.tools/docs)

  • notebook_requirements: says once that the form accepts only package==version, and that ranges appear only in a requirements.yaml edited on GitHub.
  • personal_access_token: step 9 named a non-existent field. The page now names where the token is used (initialiser, upload form, private-repo Welcome/version check), why a classic repo token is needed (ghp_), the expiry, and a new "Renew or revoke" section. before_getting_started lists the token.
  • troubleshooting_installed_app: no template version numbers; the kernel-folder deletion becomes an advanced step.
  • notebook_usage → "Open and use an app", the single first-run page. The site's using-apps page will redirect here.
  • One update page: template_synchronization.md, titled "Keep your app up to date". keep_app_up_to_date.md becomes a pointer, because many workflows and migrations link the former.
  • tools_bridge: "(optional)" removed from the title.
  • executable_creation: a "Check before you release" list and a link to Submit your app.
  • notebook_upload: "through" → "throw". app_manifest: arm64 targets build nothing yet.
  • download_executable_template: the new usage-page title.

Migration 0.1.37 → 0.1.38: files are replaced whole only when they are still the 0.1.37 copy, otherwise SKIPPED with a by-hand note. Nothing is created or deleted. Design note: .tools/docs/migration_0_1_38.md.

Tests: tests/_v0_1_38.py (before_0_1_38), chained from before_0_1_37, plus tests/test_template_sync_0_1_38.py. The full suite passes locally (2 skipped); mypy and ruff (CI version) are clean.


Generated by Claude Code

…e==version

Version ranges appear only in a requirements.yaml edited directly on GitHub; the merge
keeps and combines them, so the later section no longer reads as a contradiction.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…, expiry and revoking

Step 9 names the initialiser, the upload form and the Welcome notebook / first-cell version
check of a private repository; before_getting_started lists the token in its requirements
(initialise_repository already links the page where the token is first needed).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
App users cannot see the template version: each fix says to install the newest release of
the app; deleting the personal kernel folder becomes an advanced step after it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
… page for app users

Merges the website's hand-written "Open and use an app" page: open the app, the Welcome
notebook, run a notebook (code hiding shown with the toolbar pictures), the app's example,
napari/Fiji/QuPath, results, Colab, update, close, and where to look when something fails.
Links outside the template docs are absolute website links. install.md, executable_creation.md
and the docs README use the new title.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
… app up to date"

keep_app_up_to_date.md is merged into template_synchronization.md (the name more links point
to: sync_template.yml, the README, troubleshooting, the 0.1.12 migration, the website) and
becomes a short pointer page that leaves the docs README. app_manifest, create_repository,
executable_creation and troubleshooting link the merged page; the footers follow the index.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
executable_creation checks distribution.platforms and that every workflow run is green before
the release, and links Submit your app; tools_bridge drops "(optional)" from its title (it
opens the Connect track); app_manifest says windows-arm64 / linux-arm64 build nothing yet;
notebook_upload: "through" -> "throw".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
v0_1_37_to_v0_1_38.py replaces sixteen files of .tools/docs whole, only when the app's copy is
still the 0.1.37 template file (LF comparison, the app's line endings kept, SKIPPED otherwise,
nothing created or deleted). keep_app_up_to_date.md becomes the pointer page and the docs
README drops it only when they are the 0.1.37 template copies; a skipped one gets a note of
what to change by hand. external_code_upload.md is also recognised with the app's package
name. Resources: the new pages and previous/ (the 0.1.37 pages). Design note
migration_0_1_38.md (not listed in the index).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
…_1_38.py)

before_0_1_38 gives the frozen 0.1.37 copy of a file that is the 0.1.38 page; it is chained
into before_0_1_37, and the 0.1.20, 0.1.21 and 0.1.37 tests use it where they read a live
guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
Resources are the live files and differ from the frozen 0.1.37 copies; a 0.1.37 app reaches
the live files (LF and CRLF kept) and a second run changes nothing; a customised guide, the
pointer page and the docs README written by the form are SKIPPED (the last two with a note of
what to change by hand); external_code_upload.md with the package name; missing files are not
created; sync.py from 0.1.37 and the chain from 0.1.36. Also checks the first-run page, the one
update page and its pointer, no template versions for app users, the token page, the tools
guide title, the footers and the relative links.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WX6rdRdA72nsUjZvTXFSbP
@guijacquemet
guijacquemet merged commit ed5e4dc into main Nov 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants